{"type":"object","description":"Generic Body for a payment initiation via JSON.\n","allOf":[{"x-parent":"abstract","type":"object","description":"Generic body for updating a standing order.\n","required":["debtorAccount","instructedAmount"],"properties":{"endToEndIdentification":{"type":"string","maxLength":35},"debtorAccount":{"type":"object","description":"Details of the account from which the amount will be debited.","required":["accountId","currency"],"properties":{"accountId":{"type":"string","description":"The ID of the account that will be debited.","example":"4ec4e5f6-1124-5678-abcd-1234567890ef"},"currency":{"description":"ISO 4217 Alpha 3 currency code.\n","type":"string","pattern":"[A-Z]{3}","example":"EUR","x-field-extra-annotation":"@com.plumery.payments.api.external.models.ValidCurrency"}}},"instructedAmount":{"type":"object","required":["currency","amount"],"properties":{"currency":{"description":"ISO 4217 Alpha 3 currency code.\n","type":"string","pattern":"[A-Z]{3}","example":"EUR","x-field-extra-annotation":"@com.plumery.payments.api.external.models.ValidCurrency"},"amount":{"description":"The amount given with fractional digits, where fractions must be compliant to the currency definition.\nUp to 14 significant figures. Negative amounts are signed by minus.\nThe decimal separator is a dot.\n\n**Example:**\nValid representations for EUR with up to two decimals are:\n\n  * 1056\n  * 5768.2\n  * -1.50\n  * 5877.78\n","type":"string","pattern":"-?[0-9]{1,14}(\\.[0-9]{1,3})?","example":"5877.78"}}},"creditorAccount":{"description":"Reference to a creditor account.\n","type":"object","properties":{"iban":{"description":"IBAN of an account.","type":"string","pattern":"[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}","example":"FR7612345987650123456789014"},"bban":{"description":"Basic Bank Account Number (BBAN) Identifier.","type":"string","pattern":"[a-zA-Z0-9]{1,30}","example":"BARC12345612345678"},"msisdn":{"description":"Mobile phone number.","type":"string","maxLength":35,"example":"+49 170 1234567"},"other":{"description":"In cases where the specifically defined criteria (IBAN, BBAN, MSISDN) are not provided to identify an instance of the respective account type (e.g. a savings account), the ASPSP shall include a proprietary ID of the respective account that uniquely identifies the account for this ASPSP.","type":"object","required":["identification"],"properties":{"identification":{"description":"Proprietary identification of the account.","type":"string","maxLength":35},"schemeNameCode":{"description":"An entry provided by an external ISO code list.","type":"string","maxLength":35},"schemeNameProprietary":{"description":"A scheme name defined in a proprietary way.","type":"string","maxLength":35},"issuer":{"description":"A scheme name defined in a proprietary way.","type":"string","maxLength":35}}},"cashAccountType":{"description":"ExternalCashAccountType1Code from ISO 20022.","type":"string"},"currency":{"description":"ISO 4217 Alpha 3 currency code.\n","type":"string","pattern":"[A-Z]{3}","example":"EUR","x-field-extra-annotation":"@com.plumery.payments.api.external.models.ValidCurrency"}}},"creditorAgent":{"description":"BICFI\n","type":"string","pattern":"[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}","example":"AAAADEBBXXX"},"creditorName":{"description":"Creditor name.","type":"string","maxLength":70,"example":"Creditor Name"},"debtorAddress":{"type":"object","required":["country"],"properties":{"streetName":{"description":"Name of a street or thoroughfare\n","type":"string","example":"Main St"},"buildingNumber":{"description":"Number that identifies the position of a building on a street\n","type":"string","example":"123"},"buildingName":{"description":"Name of the building or house\n","type":"string","example":"Empire State Building"},"floor":{"description":"Floor or storey within a building\n","type":"string","example":"5"},"postBox":{"description":"Numbered box in a post office, assigned to a person or organisation, where letters are kept until called for\n","type":"string","example":"PO Box 789"},"suite":{"description":"Building room number\n","type":"string","example":"Suite 101"},"postCode":{"description":"Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail\n","type":"string","example":"90210"},"townName":{"description":"Name of a built-up area, with defined boundaries, and a local government\n","type":"string","example":"New York"},"townLocationName":{"description":"Specific location name within the town\n","type":"string","example":"Manhattan"},"districtName":{"description":"Identifies a subdivision within a country sub-division\n","type":"string","example":"Financial District"},"countrySubDivision":{"description":"Identifies a subdivision of a country such as state, region, county\n","type":"string","example":"New York State"},"country":{"description":"Nation with its own government. ISO 3166, Alpha-2 code\n","type":"string","example":"US"}}},"creditorAddress":{"type":"object","required":["country"],"properties":{"streetName":{"description":"Name of a street or thoroughfare\n","type":"string","example":"Main St"},"buildingNumber":{"description":"Number that identifies the position of a building on a street\n","type":"string","example":"123"},"buildingName":{"description":"Name of the building or house\n","type":"string","example":"Empire State Building"},"floor":{"description":"Floor or storey within a building\n","type":"string","example":"5"},"postBox":{"description":"Numbered box in a post office, assigned to a person or organisation, where letters are kept until called for\n","type":"string","example":"PO Box 789"},"suite":{"description":"Building room number\n","type":"string","example":"Suite 101"},"postCode":{"description":"Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail\n","type":"string","example":"90210"},"townName":{"description":"Name of a built-up area, with defined boundaries, and a local government\n","type":"string","example":"New York"},"townLocationName":{"description":"Specific location name within the town\n","type":"string","example":"Manhattan"},"districtName":{"description":"Identifies a subdivision within a country sub-division\n","type":"string","example":"Financial District"},"countrySubDivision":{"description":"Identifies a subdivision of a country such as state, region, county\n","type":"string","example":"New York State"},"country":{"description":"Nation with its own government. ISO 3166, Alpha-2 code\n","type":"string","example":"US"}}},"remittanceInformationUnstructured":{"description":"Unstructured remittance information.\n","type":"string","maxLength":140,"example":"Ref Number Merchant"},"remittanceInformationStructured":{"type":"object","required":["reference"],"properties":{"reference":{"type":"string"},"referenceType":{"type":"string"},"referenceIssuer":{"type":"string"}}},"paymentType":{"description":"Specifies the payment type.\nAllowed values:\n- SEPA Instant payment          \n  ```\n  \"paymentType\": {\n      \"serviceLevel\": \"SEPA\",\n      \"localInstrument\": \"INST\",\n      \"categoryPurpose\": null,\n      \"routingPreference\": \"INSTANT\"\n     }\n  }\n  ```\n- SEPA Regular payment\n  ```\n  \"paymentType\": {\n      \"serviceLevel\": \"SEPA\",\n      \"localInstrument\": \"SCT\",\n      \"categoryPurpose\": null,\n      \"routingPreference\": \"NONE\"\n    }\n  }\n  ```\n- SEPA Any payment\n  ```\n  \"paymentType\": {\n      \"serviceLevel\": \"SEPA\",\n      \"localInstrument\": null,\n      \"categoryPurpose\": null,\n      \"routingPreference\": \"NONE\"\n     }\n  }\n  ```\n- Internal payment\n  ```\n  \"paymentType\": {\n      \"serviceLevel\": \"INTERNAL\",\n      \"localInstrument\": \"INTERNAL\",\n      \"categoryPurpose\": null,\n      \"routingPreference\": \"NONE\"\n      }\n   }\n    ```\n- SWIFT payment\n  ```\n  \"paymentType\": {\n      \"serviceLevel\": \"SDVA\",\n      \"localInstrument\": \"SWIFT\",\n      \"categoryPurpose\": null,\n      \"routingPreference\": \"HIGH_PRIORITY\"\n      }\n  }\n  ```\n- OTHER payment\n  ```\n  \"paymentType\": {\n      \"serviceLevel\": \"OTHER\",\n      \"localInstrument\": \"OTHER\",\n      \"categoryPurpose\": null,\n      \"routingPreference\": \"NONE\"\n     }\n  }\n  ```\n","type":"object","required":["serviceLevel"],"properties":{"serviceLevel":{"description":"Specifies the service level for the payment\n","type":"string","enum":["SEPA","INTERNAL","SDVA","OTHER"],"example":"SEPA"},"localInstrument":{"description":"Specifies the local instrument for the payment.\nallowed values: OTHER, SWIFT, INTERNAL, SCT, INST\n","type":"string","example":"INST"},"categoryPurpose":{"description":"Specifies the category purpose for the payment\n","type":"string"},"routingPreference":{"description":"Specifies the routing preference for the payment\n","type":"string","enum":["NONE","HIGH_PRIORITY","INSTANT"],"example":"INSTANT"}}},"supplementaryData":{"description":"Additional information that cannot be captured in the structured elements and/or any other specific block.\n","type":"object","properties":{"amkCode":{"type":"string"}}}}},{"type":"object"}],"properties":{"counterpartyId":{"type":"string","maxLength":36,"description":"The Id of the counterparty.\n","example":"9857dab5-973b-4bf4-8031-e9baa5e61607"},"paymentMethodId":{"type":"string","maxLength":36,"minLength":36,"description":"The Id of the payment method.\n","example":"494bbc67-387c-4e5a-b625-00287a8fc5cc"}}}